Class ParameterMapImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ParameterMapImpl
All Implemented Interfaces:
IPCObject, ParameterMap

public class ParameterMapImpl extends IPCObjectImpl implements ParameterMap
Information provided by the PKI file:

    \class ParameterMap
    
    \brief ParameterMap handles and manipulates Zone-Based Policy Firewall parameter maps.
    
    \example network().getDevice("Router0").getParameterMapManager().getParameterMapAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getMapName

      public String getMapName()
      Information provided by the PKI file:
      
          \brief Returns the name of the paramter map.
          
          \return string, the name of the paramter map.
          
              
      Specified by:
      getMapName in interface ParameterMap
      Returns:
      String Returns a String
    • getMapType

      public ZfwMapType getMapType()
      Information provided by the PKI file:
      
          \brief Returns the type of the paramter map.
          
          \return ZfwMapType, the type of the paramter map.
          Map types:  type_default = 0,
          type_global = 1,
          type_inspect = 2,
          
              
      Specified by:
      getMapType in interface ParameterMap
      Returns:
      ZfwMapType Returns a ZfwMapType
    • setInUsed

      public void setInUsed(boolean p_used)
      Information provided by the PKI file:
      
          \brief Sets the parameter map as in use or not in use.
          
          \param p_used, true for in use, false for not in use.
          
              
      Specified by:
      setInUsed in interface ParameterMap
      Parameters:
      p_used - Takes in a parameter of p_used
    • setMapType

      public void setMapType(ZfwMapType mapType)
      Information provided by the PKI file:
      
          \brief Sets the type of the paramter map.
          
          \param mapType,     the type of the paramter map.
          Map types:  type_default = 0,
          type_global = 1,
          type_inspect = 2,
          
              
      Specified by:
      setMapType in interface ParameterMap
      Parameters:
      mapType - Takes in a parameter of mapType
    • setAlert

      public void setAlert(boolean p_on_off)
      Information provided by the PKI file:
      
          \brief Turns on or off alert.
          
          \param p_on_off, true to enable alert, false to disable it.
          
              
      Specified by:
      setAlert in interface ParameterMap
      Parameters:
      p_on_off - Takes in a parameter of p_on_off
    • setAlertEnable

      public void setAlertEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables alert.
          
          \param p_enable, true to enable alert, false to disable it.
          
              
      Specified by:
      setAlertEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setAuditTrail

      public void setAuditTrail(boolean p_on_off)
      Information provided by the PKI file:
      
          \brief Turns on or off audit-trail.
          
          \param p_on_off, true to enable audit-trail, false to disable it.
          
              
      Specified by:
      setAuditTrail in interface ParameterMap
      Parameters:
      p_on_off - Takes in a parameter of p_on_off
    • setAuditTrailEnable

      public void setAuditTrailEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables audit-trail.
          
          \param p_enable, true to enable audit-trail, false to disable it.
          
              
      Specified by:
      setAuditTrailEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setDnsTimeout

      public void setDnsTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the dns-timeout value.
          
          \param p_time, the dns-timeout value.
          
              
      Specified by:
      setDnsTimeout in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setDnsTimeoutEnable

      public void setDnsTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables dns-timeout.
          
          \param p_enable, true to enable dns-timeout, false to disable it.
          
              
      Specified by:
      setDnsTimeoutEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setIcmpIdleTimeout

      public void setIcmpIdleTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the icmp idle-timeout value.
          
          \param p_time, the icmp idle-timeout value.
          
              
      Specified by:
      setIcmpIdleTimeout in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setIcmpIdleTimeoutEnable

      public void setIcmpIdleTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables icmp idle-timeout.
          
          \param p_enable, true to enable icmp idle-timeout, false to disable it.
          
              
      Specified by:
      setIcmpIdleTimeoutEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setMaxIncompleteLow

      public void setMaxIncompleteLow(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the max-incomplete low value.
          
          \param p_num, the max-incomplete low value.
          
              
      Specified by:
      setMaxIncompleteLow in interface ParameterMap
      Parameters:
      p_num - Takes in a parameter of p_num
    • setMaxIncompleteLowEnable

      public void setMaxIncompleteLowEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables max-incomplete low.
          
          \param p_enable, true to enable max-incomplete low, false to disable it.
          
              
      Specified by:
      setMaxIncompleteLowEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setMaxIncompleteHigh

      public void setMaxIncompleteHigh(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the max-incomplete high value.
          
          \param p_num, the max-incomplete high value.
          
              
      Specified by:
      setMaxIncompleteHigh in interface ParameterMap
      Parameters:
      p_num - Takes in a parameter of p_num
    • setMaxIncompleteHighEnable

      public void setMaxIncompleteHighEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables max-incomplete high.
          
          \param p_enable, true to enable max-incomplete high, false to disable it.
          
              
      Specified by:
      setMaxIncompleteHighEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setSessionMax

      public void setSessionMax(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the session max value.
          
          \param p_num, the session max value.
          
              
      Specified by:
      setSessionMax in interface ParameterMap
      Parameters:
      p_num - Takes in a parameter of p_num
    • setSessionMaxEnable

      public void setSessionMaxEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables session max.
          
          \param p_enable, true to enable session max, false to disable it.
          
              
      Specified by:
      setSessionMaxEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setOneMinLow

      public void setOneMinLow(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the one-minute low value.
          
          \param p_num, the one-minute low value.
          
              
      Specified by:
      setOneMinLow in interface ParameterMap
      Parameters:
      p_num - Takes in a parameter of p_num
    • setOneMinLowEnable

      public void setOneMinLowEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables one-minute low.
          
          \param p_enable, true to enable one-minute low, false to disable it.
          
              
      Specified by:
      setOneMinLowEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setOneMinHigh

      public void setOneMinHigh(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the one-minute high value.
          
          \param p_num, the one-minute high value.
          
              
      Specified by:
      setOneMinHigh in interface ParameterMap
      Parameters:
      p_num - Takes in a parameter of p_num
    • setOneMinHighEnable

      public void setOneMinHighEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables one-minute high.
          
          \param p_enable, true to enable one-minute high, false to disable it.
          
              
      Specified by:
      setOneMinHighEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpFinWaitTimeout

      public void setTcpFinWaitTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp finwait-time value.
          
          \param p_time, the tcp finwait-time value.
          
              
      Specified by:
      setTcpFinWaitTimeout in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpFinWaitTimeoutEnable

      public void setTcpFinWaitTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp finwait-time.
          
          \param p_enable, true to enable tcp finwait-time, false to disable it.
          
              
      Specified by:
      setTcpFinWaitTimeoutEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpIdleTimeout

      public void setTcpIdleTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp idle-time value.
          
          \param p_time, the tcp idle-time value.
          
              
      Specified by:
      setTcpIdleTimeout in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpIdleTimeoutEnable

      public void setTcpIdleTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp idle-time.
          
          \param p_enable, true to enable tcp idle-time, false to disable it.
          
              
      Specified by:
      setTcpIdleTimeoutEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpMaxIncompleteConn

      public void setTcpMaxIncompleteConn(int p_num)
      Information provided by the PKI file:
      
          \brief Sets the tcp max-incomplete host value.
          
          \param p_num, the tcp max-incomplete host value.
          
              
      Specified by:
      setTcpMaxIncompleteConn in interface ParameterMap
      Parameters:
      p_num - Takes in a parameter of p_num
    • setTcpMaxIncompleteConnEnable

      public void setTcpMaxIncompleteConnEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp max-incomplete host.
          
          \param p_enable, true to enable tcp max-incomplete host, false to disable it.
          
              
      Specified by:
      setTcpMaxIncompleteConnEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpMaxIncompleteConnBlockTime

      public void setTcpMaxIncompleteConnBlockTime(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp max-incomplete host block-time value.
          
          \param p_time, the tcp max-incomplete host block-time value.
          
              
      Specified by:
      setTcpMaxIncompleteConnBlockTime in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpMaxIncompleteConnBlockTimeEnable

      public void setTcpMaxIncompleteConnBlockTimeEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp max-incomplete host block-time.
          
          \param p_enable, true to enable tcp max-incomplete host block-time, false to disable it.
          
              
      Specified by:
      setTcpMaxIncompleteConnBlockTimeEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setTcpSynWaitTimeout

      public void setTcpSynWaitTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the tcp synwait-time value.
          
          \param p_time, the tcp synwait-time value.
          
              
      Specified by:
      setTcpSynWaitTimeout in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setTcpSynWaitTimeoutEnable

      public void setTcpSynWaitTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables tcp synwait-time block-time.
          
          \param p_enable, true to enable tcp synwait-time, false to disable it.
          
              
      Specified by:
      setTcpSynWaitTimeoutEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • setUdpIdleTimeout

      public void setUdpIdleTimeout(int p_time)
      Information provided by the PKI file:
      
          \brief Sets the udp idle-time value.
          
          \param p_time, the udp idle-time value.
          
              
      Specified by:
      setUdpIdleTimeout in interface ParameterMap
      Parameters:
      p_time - Takes in a parameter of p_time
    • setUdpIdleTimeoutEnable

      public void setUdpIdleTimeoutEnable(boolean p_enable)
      Information provided by the PKI file:
      
          \brief Enables or disables udp idle-time.
          
          \param p_enable, true to enable udp idle-time, false to disable it.
          
              
      Specified by:
      setUdpIdleTimeoutEnable in interface ParameterMap
      Parameters:
      p_enable - Takes in a parameter of p_enable
    • getAlert

      public boolean getAlert()
      Information provided by the PKI file:
      
          \brief Returns true if alert is on, otherwise false.
          
          \return bool, true if alert is on, otherwise false.
          
              
      Specified by:
      getAlert in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getAlertEnable

      public boolean getAlertEnable()
      Information provided by the PKI file:
      
          \brief Returns true if alert is enabled, otherwise false.
          
          \return bool, true if alert is enabled, otherwise false.
          
              
      Specified by:
      getAlertEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getAuditTrail

      public boolean getAuditTrail()
      Information provided by the PKI file:
      
          \brief Returns true if audit-trail is on, otherwise false.
          
          \return bool, true if audit-trail is on, otherwise false.
          
              
      Specified by:
      getAuditTrail in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getAuditTrailEnable

      public boolean getAuditTrailEnable()
      Information provided by the PKI file:
      
          \brief Returns true if audit-trail is enabled, otherwise false.
          
          \return bool, true if audit-trail is enabled, otherwise false.
          
              
      Specified by:
      getAuditTrailEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getDnsTimeout

      public int getDnsTimeout()
      Information provided by the PKI file:
      
          \brief Returns the dns-timeout value.
          
          \return int, the dns-timeout value.
          
              
      Specified by:
      getDnsTimeout in interface ParameterMap
      Returns:
      int Returns a int
    • getDnsTimeoutEnable

      public boolean getDnsTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if dns-timeout is enabled, otherwise false.
          
          \return bool, true if dns-timeout is enabled, otherwise false.
          
              
      Specified by:
      getDnsTimeoutEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getIcmpIdleTimeout

      public int getIcmpIdleTimeout()
      Information provided by the PKI file:
      
          \brief Returns the icmp idle-timeout value.
          
          \return int, the icmp idle-timeout value.
          
              
      Specified by:
      getIcmpIdleTimeout in interface ParameterMap
      Returns:
      int Returns a int
    • getIcmpIdleTimeoutEnable

      public boolean getIcmpIdleTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if icmp idle-timeout is enabled, otherwise false.
          
          \return bool, true if icmp idle-timeout is enabled, otherwise false.
          
              
      Specified by:
      getIcmpIdleTimeoutEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getMaxIncompleteLow

      public int getMaxIncompleteLow()
      Information provided by the PKI file:
      
          \brief Returns the max-incomplete low value.
          
          \return int, the max-incomplete low value.
          
              
      Specified by:
      getMaxIncompleteLow in interface ParameterMap
      Returns:
      int Returns a int
    • getMaxIncompleteLowEnable

      public boolean getMaxIncompleteLowEnable()
      Information provided by the PKI file:
      
          \brief Returns true if max-incomplete low is enabled, otherwise false.
          
          \return bool, true if max-incomplete low is enabled, otherwise false.
          
              
      Specified by:
      getMaxIncompleteLowEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getMaxIncompleteHigh

      public int getMaxIncompleteHigh()
      Information provided by the PKI file:
      
          \brief Returns the max-incomplete high value.
          
          \return int, the max-incomplete high value.
          
              
      Specified by:
      getMaxIncompleteHigh in interface ParameterMap
      Returns:
      int Returns a int
    • getMaxIncompleteHighEnable

      public boolean getMaxIncompleteHighEnable()
      Information provided by the PKI file:
      
          \brief Returns true if max-incomplete high is enabled, otherwise false.
          
          \return bool, true if max-incomplete high is enabled, otherwise false.
          
              
      Specified by:
      getMaxIncompleteHighEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getSessionMax

      public int getSessionMax()
      Information provided by the PKI file:
      
          \brief Returns the session max value.
          
          \return int, the session max value.
          
              
      Specified by:
      getSessionMax in interface ParameterMap
      Returns:
      int Returns a int
    • getSessionMaxEnable

      public boolean getSessionMaxEnable()
      Information provided by the PKI file:
      
          \brief Returns true if session max is enabled, otherwise false.
          
          \return bool, true if session max is enabled, otherwise false.
          
              
      Specified by:
      getSessionMaxEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getOneMinLow

      public int getOneMinLow()
      Information provided by the PKI file:
      
          \brief Returns the one-minute low value.
          
          \return int, the one-minute low value.
          
              
      Specified by:
      getOneMinLow in interface ParameterMap
      Returns:
      int Returns a int
    • getOneMinLowEnable

      public boolean getOneMinLowEnable()
      Information provided by the PKI file:
      
          \brief Returns true if one-minute low is enabled, otherwise false.
          
          \return bool, true if one-minute low is enabled, otherwise false.
          
              
      Specified by:
      getOneMinLowEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getOneMinHigh

      public int getOneMinHigh()
      Information provided by the PKI file:
      
          \brief Returns the one-minute high value.
          
          \return int, the one-minute high value.
          
              
      Specified by:
      getOneMinHigh in interface ParameterMap
      Returns:
      int Returns a int
    • getOneMinHighEnable

      public boolean getOneMinHighEnable()
      Information provided by the PKI file:
      
          \brief Returns true if one-minute high is enabled, otherwise false.
          
          \return bool, true if one-minute high is enabled, otherwise false.
          
              
      Specified by:
      getOneMinHighEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getTcpFinWaitTimeout

      public int getTcpFinWaitTimeout()
      Information provided by the PKI file:
      
          \brief Returns the tcp finwait-time value.
          
          \return int, the tcp finwait-time value.
          
              
      Specified by:
      getTcpFinWaitTimeout in interface ParameterMap
      Returns:
      int Returns a int
    • getTcpFinWaitTimeoutEnable

      public boolean getTcpFinWaitTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp finwait-time is enabled, otherwise false.
          
          \return bool, true if tcp finwait-time is enabled, otherwise false.
          
              
      Specified by:
      getTcpFinWaitTimeoutEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getTcpIdleTimeout

      public int getTcpIdleTimeout()
      Information provided by the PKI file:
      
          \brief Returns the tcp idle-time value.
          
          \return int, the tcp idle-time value.
          
              
      Specified by:
      getTcpIdleTimeout in interface ParameterMap
      Returns:
      int Returns a int
    • getTcpIdleTimeoutEnable

      public boolean getTcpIdleTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp idle-time is enabled, otherwise false.
          
          \return bool, true if tcp idle-time is enabled, otherwise false.
          
              
      Specified by:
      getTcpIdleTimeoutEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getTcpMaxIncompleteConn

      public int getTcpMaxIncompleteConn()
      Information provided by the PKI file:
      
          \brief Returns the tcp max-incomplete host value.
          
          \return int, the tcp max-incomplete host value.
          
              
      Specified by:
      getTcpMaxIncompleteConn in interface ParameterMap
      Returns:
      int Returns a int
    • getTcpMaxIncompleteConnEnable

      public boolean getTcpMaxIncompleteConnEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp max-incomplete host is enabled, otherwise false.
          
          \return bool, true if tcp max-incomplete host is enabled, otherwise false.
          
              
      Specified by:
      getTcpMaxIncompleteConnEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getTcpMaxIncompleteConnBlockTime

      public int getTcpMaxIncompleteConnBlockTime()
      Information provided by the PKI file:
      
          \brief Returns the tcp max-incomplete host block-time value.
          
          \return int, the tcp max-incomplete host block-time value.
          
              
      Specified by:
      getTcpMaxIncompleteConnBlockTime in interface ParameterMap
      Returns:
      int Returns a int
    • getTcpMaxIncompleteConnBlockTimeEnable

      public boolean getTcpMaxIncompleteConnBlockTimeEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp max-incomplete host block-time is enabled, otherwise false.
          
          \return bool, true if tcp max-incomplete host block-time is enabled, otherwise false.
          
              
      Specified by:
      getTcpMaxIncompleteConnBlockTimeEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getTcpSynWaitTimeout

      public int getTcpSynWaitTimeout()
      Information provided by the PKI file:
      
          \brief Returns the tcp synwait-time value.
          
          \return int, the tcp synwait-time value.
          
              
      Specified by:
      getTcpSynWaitTimeout in interface ParameterMap
      Returns:
      int Returns a int
    • getTcpSynWaitTimeoutEnable

      public boolean getTcpSynWaitTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if tcp synwait-time is enabled, otherwise false.
          
          \return bool, true if tcp synwait-time is enabled, otherwise false.
          
              
      Specified by:
      getTcpSynWaitTimeoutEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • getUdpIdleTimeout

      public int getUdpIdleTimeout()
      Information provided by the PKI file:
      
          \brief Returns the udp idle-time value.
          
          \return int, the tcp idle-time value.
          
              
      Specified by:
      getUdpIdleTimeout in interface ParameterMap
      Returns:
      int Returns a int
    • getUdpIdleTimeoutEnable

      public boolean getUdpIdleTimeoutEnable()
      Information provided by the PKI file:
      
          \brief Returns true if udp idle-time is enabled, otherwise false.
          
          \return bool, true if udp idle-time is enabled, otherwise false.
          
              
      Specified by:
      getUdpIdleTimeoutEnable in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • isInUsed

      public boolean isInUsed()
      Information provided by the PKI file:
      
          \brief Returns true if the parameter map is in use, otherwise false.
          
          \return bool, true if the parameter map is in use, otherwise false.
          
              
      Specified by:
      isInUsed in interface ParameterMap
      Returns:
      boolean Returns a boolean
    • toString

      public String toString()
      Information provided by the PKI file:
      
          \brief Returns the name of the parameter map.
          
          \return string, the name of the parameter map.
          
              
      Specified by:
      toString in interface ParameterMap
      Overrides:
      toString in class Object
      Returns:
      String Returns a String